Skip to content

docs: Character Kits, Face Rig, and cutout dialogue - #26

Closed
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-b485
Closed

docs: Character Kits, Face Rig, and cutout dialogue#26
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-b485

Conversation

@cursor

@cursor cursor Bot commented Aug 31, 2026

Copy link
Copy Markdown

Docs added/updated

Codepaths covered

  • Library CAS: app/services/character_kit_library.py, GET/PATCH/DELETE /api/v1/character-kits/library…
  • Overlay cleanup: POST /api/v1/character-kits/face-rig/cleanup (rembg U2Net, never overwrites source)
  • Client mount / inventory / prompts: ui/src/lib/characterKit.ts, characterKitFaceRig.ts, characterKitHandoff.ts
  • Dialogue planner: ui/src/lib/cutoutDialogue.tsscene.dialogueBeats + recipe APPROVED_CHARACTER_KIT
  • UI: 3D Video sidebar + Character Creator “Create / open CharacterKit Face Rig”
  • Director list: GET /api/v1/director/pipelines?limit=&offset= (limit=0 still returns the full scan)

Knowledge gaps addressed

  • Kits shipped after 2026-08-23 with no HOWUSEIT (review gate, pose-local anchors, mouth packs, CAS 409).
  • Face Rig is a 2D overlay puppet, not Hunyuan / H3 lipsync.
  • lookNotes is stripped on save (normalize_character_kit).
  • Recipe dialogue needs both a speech track and dialogueBeats; do not mix kit identities.
  • Opening Workspaces without limit re-parses every pipeline JSON.

Verified against tests/test_character_kit_library.py (7 passed) and UI kit/dialogue tests (39 passed). Documentation-only; no runtime change.

Open in Web View Automation 

Document the workspace Character Kit library, Face Rig overlays, cutout
dialogue cadence, and recipe inventory. Cross-link 3D Video / README and
record Director pipeline pagination plus the stale Scene→Recipe audit.

Co-authored-by: ignaciodelcano+dcl <ignaciodelcano+dcl@gmail.com>
@github-actions

Copy link
Copy Markdown

PR Review — Loreframe Studio

Risk: low
Scope: 7 file(s); +310/-10; docs

Automated review from scripts/analyze_pr.py. This is a heuristic pass (no LLM) so humans still own the merge decision.

Findings

  • No heuristic issues. Still run the CI checklist below.

Changed files

  • added: docs/character-kits/HOWUSEIT.md
  • modified: README.md, app/docs/API.md, docs/3d-video-compositor/HOWUSEIT.md, docs/HOWUSEIT.md, docs/scene-recipe-gap.md, docs/workspaces/HOWUSEIT.md

CONTRIBUTING checklist

  • python scripts/verify_clean_repo.py
  • python -m compileall -q app/services app/launch.py scripts
  • cd ui && npm run build if the UI changed
  • No weights, CivitAI sidecars, or generated guides
  • Stays local-first (no required accounts / telemetry)

Posted by the repo PR review workflow. Re-runs on each push to the PR.

@IAnMove

IAnMove commented Sep 2, 2026

Copy link
Copy Markdown
Owner

Superseded by #94, which is already on main (docs: document Character Kits, Face Rig, and cutout dialogue). This branch is the older Cursor docs pass of the same guide; do not merge it in parallel.

Closing and keeping the branch.

@IAnMove

IAnMove commented Sep 2, 2026

Copy link
Copy Markdown
Owner

Closed as superseded by #94. Branch kept.

@IAnMove IAnMove closed this Sep 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants